Skip to content

Gorgias internal notes #17599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

seynadio
Copy link
Contributor

@seynadio seynadio commented Jul 14, 2025

WHY

  1. Enhanced create-ticket-message action (create-ticket-message.mjs):
    • Added channel prop with support for "internal-note"
    • Hide from/to fields when internal notes are selected (since they don't need recipients)
    • Modified validation to skip sender/receiver checks for internal notes
    • Updated message creation logic to handle internal notes properly
  2. New internal-note-created webhook source:
    - Created dedicated webhook source for internal note events
    - Filters specifically for channel === "internal-note"
    - Includes test event sample
  3. Updated package version to 0.5.2

Summary by CodeRabbit

  • New Features

    • Added the ability to create and add internal notes to Freshdesk tickets.
    • Introduced a new "New Internal Note" event source for Gorgias, allowing detection of internal note creation on tickets.
    • Added support for sending internal notes or ticket messages in Gorgias, with a new channel selection option.
  • Bug Fixes

    • Improved visibility logic for user and customer fields when creating Gorgias ticket messages, ensuring proper hiding for internal notes.
  • Chores

    • Updated version numbers for Freshdesk and Gorgias integrations.

seynadio added 2 commits July 14, 2025 10:42
- Add channel selection to create-ticket-message action with internal-note support
- Hide from/to fields for internal notes as they don't require recipients
- Add dedicated internal-note-created webhook source for better filtering
- Update package version to 0.5.2
Copy link

vercel bot commented Jul 14, 2025

@seynadio is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Walkthrough

The changes introduce the ability to handle internal notes for tickets in both Freshdesk and Gorgias integrations. Freshdesk's update-ticket action now supports adding internal notes, while Gorgias gains a new action prop for internal notes, a new event source for detecting internal note creation, and a test event. The Gorgias package version is incremented.

Changes

File(s) Change Summary
components/freshdesk/actions/update-ticket/update-ticket.mjs Added support for adding internal notes to tickets via new props and control flow; version bumped to 0.0.2.
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs Added channel prop (default "email"); logic for internal notes; payload/validation refactor; version to 0.0.3.
components/gorgias_oauth/package.json Version incremented from 0.5.1 to 0.5.2.
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs New source: emits events for new internal notes on tickets; filtering by ticket ID and sender email supported.
components/gorgias_oauth/sources/internal-note-created/test-event.mjs New: Exports a sample event object representing an internal note for testing the new source.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FreshdeskAction
    participant FreshdeskAPI

    User->>FreshdeskAction: Run update-ticket (with/without internalNote)
    alt internalNote is true and noteBody provided
        FreshdeskAction->>FreshdeskAPI: POST /tickets/{ticketId}/notes (private note)
        FreshdeskAPI-->>FreshdeskAction: Note creation response
        FreshdeskAction-->>User: Export summary and response
    else
        FreshdeskAction->>FreshdeskAPI: PUT /tickets/{ticketId} (update fields)
        FreshdeskAPI-->>FreshdeskAction: Ticket update response
        FreshdeskAction-->>User: Export summary and response
    end
Loading
sequenceDiagram
    participant User
    participant GorgiasAction
    participant GorgiasAPI

    User->>GorgiasAction: Run create-ticket-message (channel: "email" or "internal-note")
    alt channel is "internal-note"
        GorgiasAction->>GorgiasAPI: POST /messages (internal note payload)
        GorgiasAPI-->>GorgiasAction: Internal note creation response
        GorgiasAction-->>User: Export summary (internal note)
    else
        GorgiasAction->>GorgiasAPI: POST /messages (ticket message payload)
        GorgiasAPI-->>GorgiasAction: Ticket message creation response
        GorgiasAction-->>User: Export summary (ticket message)
    end
Loading
sequenceDiagram
    participant GorgiasWebhook
    participant InternalNoteSource
    participant User

    GorgiasWebhook-->>InternalNoteSource: Event: TICKET_MESSAGE_CREATED
    alt message.channel == "internal-note" and filters match
        InternalNoteSource-->>User: Emit internal note event
    else
        InternalNoteSource--xUser: Ignore event
    end
Loading

Poem

A note in the ticket, a whisper unseen,
Freshdesk and Gorgias join forces so keen.
Internal thoughts now safely reside,
With new props and sources, no detail can hide.
Version numbers hop, new features appear—
The rabbit applauds: more magic this year!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/freshdesk/actions/update-ticket/update-ticket.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

components/gorgias_oauth/sources/internal-note-created/test-event.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

  • 1 others

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e21d334 and db9a656.

📒 Files selected for processing (5)
  • components/freshdesk/actions/update-ticket/update-ticket.mjs (3 hunks)
  • components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (5 hunks)
  • components/gorgias_oauth/package.json (1 hunks)
  • components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (1 hunks)
  • components/gorgias_oauth/sources/internal-note-created/test-event.mjs (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
components/gorgias_oauth/package.json (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/gorgias_oauth/sources/internal-note-created/test-event.mjs (3)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-07-24T02:06:47.016Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (4)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-07-24T02:06:47.016Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (4)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14467
File: components/gainsight_px/actions/create-account/create-account.mjs:4-6
Timestamp: 2024-10-30T15:24:39.294Z
Learning: In `components/gainsight_px/actions/create-account/create-account.mjs`, the action name should be "Create Account" instead of "Create Memory".
Learnt from: js07
PR: PipedreamHQ/pipedream#17375
File: components/zerobounce/actions/get-validation-results-file/get-validation-results-file.mjs:23-27
Timestamp: 2025-07-01T17:07:48.193Z
Learning: "dir" props in Pipedream components are hidden in the component form and not user-facing, so they don't require labels or descriptions for user clarity.
🔇 Additional comments (11)
components/gorgias_oauth/package.json (1)

3-3: LGTM: Version bump is appropriate.

The version increment from 0.5.1 to 0.5.2 correctly reflects the new internal note functionality being added to the package.

components/gorgias_oauth/sources/internal-note-created/test-event.mjs (1)

1-43: LGTM: Comprehensive and realistic test event structure.

The test event accurately represents an internal note creation event with all appropriate fields:

  • Channel/via correctly set to "internal-note"
  • Public field appropriately set to false
  • Sender details provided while receiver is null (correct for internal notes)
  • Includes both HTML and text body versions
  • Comprehensive metadata structure
components/freshdesk/actions/update-ticket/update-ticket.mjs (2)

74-86: LGTM: Well-designed props for internal note functionality.

The props are appropriately structured with the boolean flag controlling the feature and the optional noteBody containing the content. The descriptions are clear and informative.


120-133: LGTM: Correct API usage and early return pattern.

The implementation correctly:

  • Uses the standard Freshdesk API endpoint for creating notes
  • Sets private: true for internal notes
  • Implements early return to avoid conflicts with regular ticket updates
  • Provides appropriate success summary
components/gorgias_oauth/sources/internal-note-created/internal-note-created.mjs (2)

8-11: LGTM: Appropriate component metadata.

The component follows naming conventions and includes proper documentation reference. The name "New Internal Note" appropriately indicates it emits events for newly created internal notes.


38-47: LGTM: Robust filtering and event processing logic.

The implementation correctly:

  • Filters events by channel === "internal-note"
  • Provides optional filtering by ticket ID and sender email
  • Uses logical AND conditions for precise filtering
  • Only emits events that pass the relevance check
components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (5)

70-78: LGTM: Well-structured channel prop with appropriate reload behavior.

The channel prop is properly configured with sensible defaults and reload behavior to update the form dynamically.


113-118: LGTM: Clean visibility logic for internal notes.

The visibility logic correctly hides sender/receiver props when dealing with internal notes, since they're not relevant for this message type.


177-189: LGTM: Appropriate validation bypass for internal notes.

The conditional validation correctly skips sender/receiver validation for internal notes while maintaining the checks for regular messages.


191-226: LGTM: Well-structured conditional payload construction.

The payload construction is cleanly separated with common fields first, then conditional addition of source/sender/receiver fields only for non-internal notes. This approach is maintainable and logically sound.


234-234: LGTM: Appropriate dynamic summary message.

The summary message correctly reflects whether an internal note or regular ticket message was created, providing clear feedback to the user.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

vercel bot commented Jul 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jul 14, 2025 9:13am

@adolfo-pd adolfo-pd added the User submitted Submitted by a user label Jul 14, 2025
@pipedream-component-development
Copy link
Collaborator

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

@pipedream-component-development
Copy link
Collaborator

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

@seynadio
Copy link
Contributor Author

Closing this PR and replacing with #17605 which has only the Gorgias changes (no accidental Freshdesk changes included)

@seynadio seynadio closed this Jul 14, 2025
@seynadio seynadio deleted the gorgias-internal-notes branch July 14, 2025 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
User submitted Submitted by a user
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants